Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add exceptions to API documentation (backport #10522) #10628

Merged
merged 2 commits into from
Aug 15, 2023
Merged

Add exceptions to API documentation (backport #10522) #10628

merged 2 commits into from
Aug 15, 2023

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Aug 14, 2023

This is an automatic backport of pull request #10522 done by Mergify.
Cherry-pick of 982807e has failed:

On branch mergify/bp/stable/0.25/pr-10522
Your branch is up to date with 'origin/stable/0.25'.

You are currently cherry-picking commit 982807e5b.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/apidocs/terra.rst
	modified:   qiskit/algorithms/amplitude_estimators/ae.py
	modified:   qiskit/circuit/__init__.py
	modified:   qiskit/circuit/exceptions.py
	modified:   qiskit/exceptions.py
	modified:   qiskit/extensions/__init__.py
	modified:   qiskit/opflow/gradients/circuit_gradients/lin_comb.py
	modified:   qiskit/providers/__init__.py
	modified:   qiskit/pulse/__init__.py
	modified:   qiskit/qasm2/__init__.py
	modified:   qiskit/qpy/__init__.py
	modified:   qiskit/qpy/exceptions.py
	modified:   qiskit/transpiler/passes/synthesis/unitary_synthesis.py

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	added by them:   docs/apidocs/exceptions.rst
	both modified:   qiskit/dagcircuit/__init__.py
	deleted by us:   qiskit/passmanager/__init__.py
	both modified:   qiskit/transpiler/__init__.py

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com

@jakelishman @mergify
Add exceptions to API documentation (#10522)
9412a53 
The big change here is that `QiskitError` is added to the API
documentation, which causes 400--500 previously failing Sphinx lookups
(stemming from "Raises:" documentation) to now succeed.  This commit
also corrects several other places where exceptions were not being fully
documented (and in several cases makes the imports more convenient as
well), and corrects a couple of places with incorrect references to
exceptions.

(cherry picked from commit 982807e)

# Conflicts:
#	docs/apidocs/exceptions.rst
#	qiskit/dagcircuit/__init__.py
#	qiskit/passmanager/__init__.py
#	qiskit/transpiler/__init__.py
@mergify mergify bot requested a review from alexanderivrii as a code owner August 14, 2023 22:59
@mergify mergify bot added the conflicts used by mergify when there are conflicts in a port label Aug 14, 2023
@qiskit-bot
Copy link
Collaborator

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

Eric-Arellano
Eric-Arellano previously approved these changes Aug 14, 2023
View reviewed changes
@mtreinish
Fix merge conflicts
e883dca 
This commit fixes several merge conflicts in the backport. They were
mostly minor differences between main and the stable branch that needed
to be corrected.
@mtreinish mtreinish added Changelog: None Do not include in changelog and removed conflicts used by mergify when there are conflicts in a port labels Aug 15, 2023
@mtreinish mtreinish added this to the 0.25.1 milestone Aug 15, 2023
@coveralls
Copy link

Pull Request Test Coverage Report for Build 5866702638

  • 8 of 8 (100.0%) changed or added relevant lines in 8 files are covered.
  • 3 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.002%) to 87.219%
Files with Coverage Reduction New Missed Lines %
qiskit/extensions/unitary.py 1 93.75%
crates/qasm2/src/lex.rs 2 91.14%
Totals Coverage Status
Change from base Build 5861252133: 0.002%
Covered Lines: 74065
Relevant Lines: 84918
💛 - Coveralls

@mtreinish mtreinish added this pull request to the merge queue Aug 15, 2023
Merged via the queue into stable/0.25 with commit 43ce89f Aug 15, 2023
14 checks passed
@mergify mergify bot deleted the mergify/bp/stable/0.25/pr-10522 branch August 15, 2023 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mtreinish mtreinish mtreinish approved these changes

@Eric-Arellano Eric-Arellano Eric-Arellano left review comments

@alexanderivrii alexanderivrii Awaiting requested review from alexanderivrii alexanderivrii is a code owner

@ShellyGarion ShellyGarion Awaiting requested review from ShellyGarion ShellyGarion is a code owner

@eggerdj eggerdj Awaiting requested review from eggerdj eggerdj is a code owner

@wshanks wshanks Awaiting requested review from wshanks wshanks is a code owner

@jyu00 jyu00 Awaiting requested review from jyu00 jyu00 is a code owner

@woodsp-ibm woodsp-ibm Awaiting requested review from woodsp-ibm woodsp-ibm is a code owner

@ikkoham ikkoham Awaiting requested review from ikkoham

@ElePT ElePT Awaiting requested review from ElePT ElePT is a code owner

Assignees
No one assigned
Labels
Changelog: None Do not include in changelog
Projects
None yet
Milestone
0.25.1
Development

Successfully merging this pull request may close these issues.
5 participants
@qiskit-bot @coveralls @mtreinish @Eric-Arellano @jakelishman